home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / SYS / CDPLAY / !CDPlay / !Help < prev    next >
Text File  |  1997-06-18  |  14KB  |  436 lines
  1. Help file for !CDPlay
  2. ~~~~~~~~~~~~~~~~~~~~~
  3.  
  4.   Application : CDPlay
  5.   Purpose     : Filer Like CD Player
  6.   Version     : 1.13
  7.   Author      : Leo White
  8.   Date        : Wed 18th June 1997
  9.          
  10. © Leo White, 1996/97
  11.  
  12. CDFilter Module © Phillip Camp 1996
  13.  
  14. --------------------------------------------------------------------
  15.  
  16.   CDPlay is a small program to be used for playing Audio CD's.  It 
  17. was written by me when I got a CD-ROM drive for my 4MB A5000 and 
  18. found out that the supplied CD Player took up 160K of memory.  After
  19. looking around and not finding any other player with decent features
  20. that used less then 96K of memory, I decided to write my own.
  21.  
  22.   CDPlay attempts to display the track information in a style similar
  23. to the 'Fill info' option on a Filer Window.  I.e. it displays track
  24. number, name and size in the same sort of layout.
  25.  
  26.   CDPlay can support multiply CDROM drives, enabling you to use just
  27. one program to control them all, and can store CD details on to disk
  28. and recall them next time you use that CD.
  29.  
  30.   It also has function for random and program play, and the usual
  31. time display option.
  32.  
  33. --------------------------------------------------------------------
  34.  
  35. Instructions
  36. ~~~~~~~~~~~~
  37.  
  38.   CDPlay does not use an icon on the icon bar.  Instead you can 
  39. open and close the main window in two ways.  First is by adjust
  40. clicking on the CD Drive icon on the iconbar.  The second way is
  41. by a user configurable hotkey.  By default this is CTRL-SHIFT-TAB.
  42.  
  43.   The main window consists of the CD Title, current track name,
  44. the CD controls, current track number, time, and a volume bar.
  45.  
  46.  
  47.   CD Controls
  48.   ~~~~~~~~~~~
  49.   
  50.   The control icons are, from left to right:
  51.   
  52.     R     - When depressed, selects Random play.
  53.     M     - When depressed, selects memory play
  54.     Pause - Pause
  55.     Previous - When 'Select' clicked, jumps to start of current track,
  56.                or begining of next track.
  57.                When 'Adjust' click, acts as rewind.
  58.     Next     - When 'Select' clicked, jumps to start of Next track.
  59.                When 'Adjust' clicked, acts as fast forwards.
  60.     Stop     - Stop
  61.     Eject    - When 'Select' clicked, attempts to eject or close the
  62.                CD drawer depending on current status.
  63.                When 'Adjust' clicked, forces the drive to eject, as
  64.                CDFS can't tell the difference between an empty drive,
  65.                and an open drawer drive.
  66.     Play     - Play
  67.     
  68.  
  69.   Time
  70.   ~~~~
  71.   
  72.   The time format can be toggled by clicking on the time part of the
  73.   icon.           
  74.   
  75.   Volume
  76.   ~~~~~~
  77.   
  78.   The volume can be changed by clicking on the appropiate part of
  79.   the bar, or by dragging the slider left and right.  
  80.   This option will only work on drives that support it, and with
  81.   a version of CDFS that supports it.
  82.   
  83.   Track Information
  84.   ~~~~~~~~~~~~~~~~~
  85.   
  86.   Track Number - Plays the appropiate track
  87.   Track Name   - Displays track name.  Click on the icon to edit it.
  88.   Time         - Shows the tracks total length.
  89.   
  90.  
  91.   Menu
  92.   ~~~~
  93.   
  94.   Apart from the standard Info and Quit options, you also have,
  95.   
  96.   Program - Opens the program window.
  97.   Choices - Loads up the configuration program
  98.   Save    - Saves the current CD Details to disc.
  99.   
  100.  
  101.   The Program Window
  102.   ~~~~~~~~~~~~~~~~~~
  103.   
  104.   First off, you CANNOT edit the list of tracks manually.  The only
  105.   reason the icon is writeable, is so that you can scroll the list
  106.   left and right.
  107.   
  108.   To create a program, either select Random, which will generate a random
  109.   program made up of all the tracks.  Or select 'Program' and then
  110.   click on the track numbers in the main window to add them to the
  111.   list.
  112.  
  113.   The Choices Program
  114.   ~~~~~~~~~~~~~~~~~~~
  115.   
  116.   Most of these options are self explainatery.  But I list here a
  117.   few that may need explaining.
  118.   
  119.   CD matching offset
  120.     Different CDROM drives can report different unique numbers for
  121.     the same CD.  This option enables you to configure the boundaries
  122.     for matching CD's.  CDPlay will look for a CD in the range of
  123.     'Reported number +- offset'
  124.     This option is only useful if you have more than one CDROM drive,
  125.     or you have got a list of CD Details from someone else.
  126.     
  127.   Autodetect CD Change
  128.     CDPlay normally checks at regular intervals if the current CD that is 
  129.     in the drive is the one that it thinks it is playing. This does
  130.     not work with some CDFS drivers, and causes the CDPlay to rescan
  131.     the Listings file to match the CD.  If you have this problem, then
  132.     turn this option off.  The only problem you should then get is if
  133.     you change the CD whilst single tasking, as CDPlay will not spot the
  134.     change.
  135.     
  136.   Check if track is audio
  137.     Some CDFS drivers do not support this.  So if you find that CDPlay
  138.     refuses to plau audio tracks, then try turning this option off.
  139.     
  140.   Hotkey code
  141.     This is the hotkey code that opens and closes the main window.
  142.     To change, click in the icon, and press the desired hotkey, and the
  143.     code should then change.
  144.     
  145.   Save current window position
  146.     When selected, the current location of the main window AT THE TIME
  147.     THAT YOU SAVE THE CONFIGURATION will be saved, and the window
  148.     will be opened at that location next time that you run CDPlay.
  149.     
  150.         
  151.  
  152.   The Listing File
  153.   ~~~~~~~~~~~~~~~~
  154.   
  155.   This is where CDPlay stores its information on CDs.
  156.   
  157.   To merge the current Listing file with a new one.  Drag the new
  158.   Listing file onto CDPlay's main window.  The new Lising file
  159.   must be either set to text, or data.
  160.   
  161.   SMART CD+ users.  CDPlay can convert and use the Smart CD Version 2
  162.   listing files.  Just drag the Smart CD listing file onto CDPlay's main
  163.   window as mentioned above. 
  164.   
  165.   
  166. --------------------------------------------------------------------
  167.  
  168. Things To Do
  169. ~~~~~~~~~~~~
  170.  
  171.   -Expand the memory play routines.  Allow saving of playlists etc.
  172.   -Add interactive help.  
  173.   -Rewrite at last part of the program as a module, so it works 
  174.    even whilst outside of the desktop.  i.e When playing games.
  175.    
  176. --------------------------------------------------------------------
  177.  
  178. Program History
  179. ~~~~~~~~~~~~~~~
  180.  
  181. Version 0.01
  182. ~~~~~~~~~~~~
  183.  
  184. Created Template And Sprite files, And Copied Basic Code From 
  185. My First Attempt At A CD Player
  186.  
  187. Version 0.02 Thu 12th September 1996
  188. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  189.  
  190. Added Code To Make The Main Window Adjust Size And Create The Icons Needed
  191. To Hold The Track Names Etc.
  192.  
  193. Version 0.03 Fri 13th September 1996
  194. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  195.  
  196. Code Added To Detect Data CD's
  197. If You Try And Play A Data Track, CDPlay Performs A Filer_OpenDir On
  198. The Root Of The CD-ROM To Open The Filer Window
  199. Link List Finished To Hold All The Track Information
  200. Added Code To Generate The Playing Time Of The Track
  201.  
  202. Version 0.04 Tue 17th September 1996
  203. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  204.  
  205. Added Memory Routines
  206. Change Merge File Procedure So It Works With Native Files Properly
  207.  
  208. Version 0.05 Sun 22nd September 1996
  209. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  210.  
  211. Tidied Up The Code
  212. Made Linked List Accessing More Memory Efficient And Faster
  213.  
  214. Version 0.06 Sat 5th October 1996
  215. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  216.  
  217. Edited The Template Files To Make Them Conform To The RISC OS 3 Style
  218. Guide To A Greater Degree
  219.  
  220. Version 0.07 Mon 7th October 1996
  221. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  222.  
  223. Added Choices Window And Saving And Loading Of Choices File
  224. Added Routines To Check If The Listing And Choices Files Exist
  225.  
  226. Version 0.08 Sat 12th October 1996
  227. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  228.  
  229. Fixed Bug, If The CD Was Stopped By CDPlay, And Started By Another Method,
  230. CDPlay Didn't Register The Fact That It Had Restarted
  231. Added Routines To Set The 'Listing' File To Protected So That It Can't
  232. Be Overwritten Or Deleted By Accident
  233.  
  234. Version 0.09 Sun 3rd November 1996
  235. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  236.  
  237. Fixed Bug Which Stopped CDPlay Being Used On Multiple Drives
  238. Added Code To Detect Return And Escape Keypresses In The Choices
  239. Window, And Perform The Appropriate Action
  240.  
  241. Version 1.00 Mon 04th November 1996
  242. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  243.  
  244. First Release Version, Finally Decided The Program Was In A Fit
  245. State To Be Released
  246.  
  247. Version 1.01 Mon 22nd November 1996
  248. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  249.  
  250. Fixed Bug In Saving CD Listing Which Could Mess Up The Listing File
  251.  
  252. Version 1.02 12 December 1996
  253. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  254.  
  255. Different CDFS drivers (e.g. ATAPI, PSLCD) return different CD ID
  256. numbers.  Added hack to enable CDs entered into the listing under
  257. one driver, to be used by the other driver.
  258. Tidied up some of the code
  259.  
  260. Version 1.03 4 January 1997
  261. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  262.  
  263. Rewrote CD Play routines, and window creation/handling routines,
  264. edited the sprite files and template files, resulting in a 25% 
  265. reduction in memory usage.  CDPlay now only requires 48k of 
  266. memory to run in, instead of 64k.
  267. Also changed the 'memory' mode.  Can now handle having the same
  268. track more than once in the Program.  Making it far more useful.
  269. Removed Listing Merge routines out of main program and into a
  270. separate application, which is called by CDPlay when needed.
  271.  
  272. Version 1.04 Wed 15th January 1997
  273. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  274.  
  275. Fixed problem with wrong Sprites file being loaded for the current 
  276. mode.
  277. Added code to listing save routines to reduce chance of corrupted 
  278. listing files.
  279. Add check to make sure Random play doesn't play the same track 
  280. twice in a row.
  281.  
  282. Version 1.05 Sun 19th January 1997
  283. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  284.  
  285. Added Menu, removed Info, Choices etc. buttons from main window
  286. to the menu.
  287. Added volume bar.
  288. Added Auto Repeat CD option in the Choices Window.
  289. Tidied up the code slightly.
  290. Hopefully fixed problem which resulted in CDPlay crashing when using
  291. the Alsystems CDFS drivers.
  292.  
  293. Version 1.06 Tue 11th February 1997
  294. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  295.  
  296. Changed Track Playing routines.
  297. Altered the code which generated track time and CD playing time.
  298. Made sure the menu closed if the window was closed, unless adjust used.
  299. Added changing of icon background colour when got input focus.
  300. Added scrolling of window to keep caret in view.
  301. Changed the Volume bar code, so it doesn't mess up as much on a system
  302. which doesn't support it.
  303.  
  304. Version 1.07 Sat 1st March 1997
  305. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  306.  
  307. Removed configuration code and turned it into a separate application.
  308. Added new configuration options :
  309.   Disable CD Scanning
  310.   Warn If Track listings Not Saved
  311.   CDMatching Offset Number
  312.   Show Track Lengths
  313.   Added 2 new Time Formats
  314.   Save Volume On Exit
  315.   Auto Save CD Listing
  316.   Changing of the Hotkey Code
  317. Wimpslot was increased to 52K :(
  318.  
  319. Version 1.08 Tue 11th March 1997
  320. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  321.  
  322. Reduced the wimpslot back down to 48k again :)
  323. Added better support for the auto save CD listings.
  324. Changed the volume support detection routines.  Hopefully
  325. will work slightly better now.
  326. Rewrote the Help file to cover the new Choices application
  327. Changed the layout of the Choices file so I could remove some
  328. code.
  329.   
  330. Version 1.09 Tue 18th March 1997
  331. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  332.  
  333. Added two new configuration options to handle problems with
  334. some CDFS drivers.
  335. Fixed a bug that was causing CDPlay to crash occasionally when
  336. redrawing the volume bar.
  337. Changed code so it displays 'CD Scanning Disabled' instead of
  338. 'Unknown' for the CD Title when that option is turned on.
  339.  
  340. Version 1.10 Thu 20th March 1997
  341. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  342.  
  343. Changed code so track names are empty if they are unknown
  344. Rewrote the Listings file merging program so it is more memory
  345. based processing.  Speeding it up considerable on larger files.
  346. Added a proper sprite for the Misc icon in the Choices program.
  347. Decided to release it if no bugs had crept in :)
  348.    
  349. Version 1.11 Tue 20th May 1997
  350. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  351.  
  352. Fixed bug.  If U saved when the drive was empty, the listing
  353. file got corrupted.  Now only saves if drive is not empty.
  354. Got the greying out of the 'Save' option in the menu working
  355. properly.
  356.  
  357. Version 1.12 Sun 25th May 1997
  358. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  359. Added Cue And rewind functions when U adjust click on the 
  360. 'Next' 'Last' icons.
  361.  
  362. Version 1.13 Tue 27th May 1997
  363. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  364. Fixed bug where the CD Title was being overwritten when a 
  365. program was created.
  366. Fixed bug in the configure program, which was causing the 
  367. machine to get stuck in an endless loop.
  368.  
  369. ----------------------------------------------------------------
  370.  
  371. Disclaimer
  372. ~~~~~~~~~~
  373.  
  374.   This software is provided as is.  The author cannot take responsibility
  375. for any loss of data or any other problems consequent upon the use of
  376. this program.
  377.  
  378. ----------------------------------------------------------------
  379.  
  380. Conditions of Use
  381. ~~~~~~~~~~~~~~~~~
  382.  
  383.   This software is freeware.  It may be freely distributed as long as no
  384. money is exchanged, apart from cost of distribution i.e. cost of discs,
  385. and that all the file are included with the possible exception
  386. of the Choices and Listing files.
  387.  
  388. ----------------------------------------------------------------
  389.  
  390. Thanks go to my beta testers for helping to find bugs,
  391. suggesting improvements and generally forcing me to make
  392. it into a releasable product, rather than the underdeveloped
  393. version that I was quite happy with at the time ;)
  394.  
  395. Thanks also go to Acorn's !CDPlayer whose large memory usage
  396. and lack of functions compelled me into writing this
  397. program in the first place.
  398.  
  399. ----------------------------------------------------------------
  400.  
  401. Updates and Listing Files
  402. ~~~~~~~~~~~~~~~~~~~~~~~~~
  403.  
  404. You can get the latest version of CDPlay from my web page
  405. at 
  406.  
  407.   http://www.ukc.ac.uk/php/lptw1
  408.   
  409. there is also a large Listing file here which contains > 1000 CD
  410. Details
  411.  
  412.  
  413. ----------------------------------------------------------------
  414.  
  415. Contacting The Author
  416. ~~~~~~~~~~~~~~~~~~~~~
  417.  
  418.   If you wish to contact me, e.g. to tell me about any bugs, 
  419. improvements etc. Or if you just want to send me large amounts of
  420. money :) (Well you never know), then you can use the following 
  421. methods.
  422.  
  423. email : lptw1@ukc.ac.uk  (Should be valid for a few more years yet)
  424.  
  425. or send mail to
  426.  
  427. L P T White
  428. 208 New Road
  429. West Parley
  430. Ferndown
  431. Dorset
  432. BH22 8EN
  433.  
  434. Any mail arriving here will be sent on to me at University. So could take
  435. quite some time to reach me.
  436.